﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class ExportDataEventArgs
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class ExportDataEventArgs
   ">
    <meta name="generator" content="docfx 2.52.0.0">
    
    <link rel="shortcut icon" href="../api/images/favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    <script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
    
    
    
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../api/images/favicon.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="SpiceSharp.Simulations.ExportDataEventArgs">
  
  
  <h1 id="SpiceSharp_Simulations_ExportDataEventArgs" data-uid="SpiceSharp.Simulations.ExportDataEventArgs" class="text-break">Class ExportDataEventArgs
  </h1>
  <div class="markdown level0 summary"><p>A class that describes exported simulation data. Can be used by simulations to pass exported simulation data as an event argument.
This class contains some helper methods for extracting data from the simulation.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">System.EventArgs</span></div>
    <div class="level2"><span class="xref">ExportDataEventArgs</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <span class="xref">System.EventArgs.Empty</span>
    </div>
    <div>
      <span class="xref">System.Object.ToString()</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="SpiceSharp.Simulations.html">SpiceSharp.Simulations</a></h6>
  <h6><strong>Assembly</strong>: SpiceSharp.dll</h6>
  <h5 id="SpiceSharp_Simulations_ExportDataEventArgs_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class ExportDataEventArgs : EventArgs</code></pre>
  </div>
  <h3 id="constructors">Constructors
  </h3>
  <a id="SpiceSharp_Simulations_ExportDataEventArgs__ctor_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.#ctor*"></a>
  <h4 id="SpiceSharp_Simulations_ExportDataEventArgs__ctor_SpiceSharp_Simulations_Simulation_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.#ctor(SpiceSharp.Simulations.Simulation)">ExportDataEventArgs(Simulation)</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="SpiceSharp.Simulations.ExportDataEventArgs.html">ExportDataEventArgs</a> class.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public ExportDataEventArgs(Simulation simulation)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.Simulation.html">Simulation</a></td>
        <td><span class="parametername">simulation</span></td>
        <td><p>The simulation.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
  </h3>
  <a id="SpiceSharp_Simulations_ExportDataEventArgs_Frequency_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.Frequency*"></a>
  <h4 id="SpiceSharp_Simulations_ExportDataEventArgs_Frequency" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.Frequency">Frequency</h4>
  <div class="markdown level1 summary"><p>Gets the frequency if the simulation supports it.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double Frequency { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_ExportDataEventArgs_Laplace_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.Laplace*"></a>
  <h4 id="SpiceSharp_Simulations_ExportDataEventArgs_Laplace" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.Laplace">Laplace</h4>
  <div class="markdown level1 summary"><p>Gets the laplace variable if the simulation supports it.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Complex Laplace { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Numerics.Complex</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_ExportDataEventArgs_Time_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.Time*"></a>
  <h4 id="SpiceSharp_Simulations_ExportDataEventArgs_Time" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.Time">Time</h4>
  <div class="markdown level1 summary"><p>Gets the time if the simulation supports it.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double Time { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
  </h3>
  <a id="SpiceSharp_Simulations_ExportDataEventArgs_GetComplexVoltage_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.GetComplexVoltage*"></a>
  <h4 id="SpiceSharp_Simulations_ExportDataEventArgs_GetComplexVoltage_System_String_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.GetComplexVoltage(System.String)">GetComplexVoltage(String)</h4>
  <div class="markdown level1 summary"><p>Gets the complex voltage at a specific node.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Complex GetComplexVoltage(string node)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">node</span></td>
        <td><p>The node name.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Numerics.Complex</span></td>
        <td><p>The extracted voltage.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="SpiceSharp_Simulations_ExportDataEventArgs_GetComplexVoltage_System_String__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>For better performance, consider using <a class="xref" href="SpiceSharp.Simulations.ComplexVoltageExport.html">ComplexVoltageExport</a></p>
</div>
  <h5 id="SpiceSharp_Simulations_ExportDataEventArgs_GetComplexVoltage_System_String__seealso">See Also</h5>
  <div class="seealso">
      <div><a class="xref" href="SpiceSharp.Simulations.ComplexVoltageExport.html">ComplexVoltageExport</a></div>
  </div>
  <a id="SpiceSharp_Simulations_ExportDataEventArgs_GetComplexVoltage_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.GetComplexVoltage*"></a>
  <h4 id="SpiceSharp_Simulations_ExportDataEventArgs_GetComplexVoltage_System_String_System_String_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.GetComplexVoltage(System.String,System.String)">GetComplexVoltage(String, String)</h4>
  <div class="markdown level1 summary"><p>Gets the differential complex voltage between two specified nodes.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Complex GetComplexVoltage(string positive, string negative)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">positive</span></td>
        <td><p>The name of the node at the positive probe.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">negative</span></td>
        <td><p>The name of the node at the negative probe.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Numerics.Complex</span></td>
        <td><p>The extracted voltage.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_ExportDataEventArgs_GetSweepValues_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.GetSweepValues*"></a>
  <h4 id="SpiceSharp_Simulations_ExportDataEventArgs_GetSweepValues" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.GetSweepValues">GetSweepValues()</h4>
  <div class="markdown level1 summary"><p>Gets the current sweep value if the simulation is a <a class="xref" href="SpiceSharp.Simulations.DC.html">DC</a> analysis.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double[] GetSweepValues()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span>[]</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_ExportDataEventArgs_GetVoltage_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.GetVoltage*"></a>
  <h4 id="SpiceSharp_Simulations_ExportDataEventArgs_GetVoltage_System_String_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.GetVoltage(System.String)">GetVoltage(String)</h4>
  <div class="markdown level1 summary"><p>Gets the voltage at a specified node.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double GetVoltage(string node)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">node</span></td>
        <td><p>The node name.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td><p>The extracted voltage.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="SpiceSharp_Simulations_ExportDataEventArgs_GetVoltage_System_String__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>For better performance, consider using <a class="xref" href="SpiceSharp.Simulations.RealVoltageExport.html">RealVoltageExport</a>.</p>
</div>
  <h5 id="SpiceSharp_Simulations_ExportDataEventArgs_GetVoltage_System_String__seealso">See Also</h5>
  <div class="seealso">
      <div><a class="xref" href="SpiceSharp.Simulations.RealVoltageExport.html">RealVoltageExport</a></div>
  </div>
  <a id="SpiceSharp_Simulations_ExportDataEventArgs_GetVoltage_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.GetVoltage*"></a>
  <h4 id="SpiceSharp_Simulations_ExportDataEventArgs_GetVoltage_System_String_System_String_" data-uid="SpiceSharp.Simulations.ExportDataEventArgs.GetVoltage(System.String,System.String)">GetVoltage(String, String)</h4>
  <div class="markdown level1 summary"><p>Gets the differential voltage between two specified nodes.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public double GetVoltage(string positive, string negative)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">positive</span></td>
        <td><p>The name of the node at the positive probe.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">negative</span></td>
        <td><p>The name of the node at the negative probe.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td><p>The extracted voltage.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="SpiceSharp.Utility.html#SpiceSharp_Utility_ThrowIfNull__1___0_System_String_">Utility.ThrowIfNull&lt;T&gt;(T, String)</a>
  </div>
  <h3 id="seealso">See Also</h3>
  <div class="seealso">
      <div><span class="xref">System.EventArgs</span></div>
  </div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
